Phone Number Active
This API helps you to get the phone number active data of your end-users.
Get started in 2 Simple Steps :
- Use the /api/data/numberActive/handle endpoint to verify the request and get the requestId.
- Use the /api/data/numberActive/query endpoint to get the data.
To access
Welcome to use our product. Here are some things you need to know before you start the interface call:
- Complete product signing and permission opening;
- You need to obtain an appKey and secret.
- We provide a demo java python php，for your reference;
- Please feel free to contact us if you have any questions.
token description
Write all request parameters and secrets (assigned when opening an account) except tokens in the form of "key=value", sort them by key, and connect them with "&" to get the string str：
String str = "appKey=test_key&idNumber=idNumber&name=name&phone=phone&secret=20200101";
Encrypt str with md5 to get the token:
String token = md5(str);
For details, please refer to calling demo
【numberActive/handle】 Interface information
| API | API information |
|---|---|
| formal environment | http://api.digiscore.id/api/data/numberActive/handle |
| sandbox environment | http://test-platform.ferrystatic.com/openrisk/api/data/numberActive/handle |
Request parameter
| Field | type | required | describe |
|---|---|---|---|
| appKey | string | yes | Unique identifier assigned to the organization |
| token | string | yes | API request signature, see token description |
| phone | string | yes | Phone number of the user. All Phone number have to remove the country prefix, and start with "8" |
Response parameters
| Field | type | required | describe |
|---|---|---|---|
| code | int | yes | error code |
| msg | string | yes | Error message |
| data | object | no | Always empty |
| requestId | string | yes | Request id |
Response example
need query
{
"code": 201,
"msg": "ok",
"data": null,
"requestId": "3ce9f0c7adxxxxxdc626cf1f7e4b",
}
error
{
"code": 11008,
"msg": "xxxxxxx",
"data": null,
"requestId": "638211dexxxxxfc77718e079f6",
}
【numberActive/query】 Interface information
| API | API information |
|---|---|
| formal environment | http://api.digiscore.id/api/data/numberActive/query |
| sandbox environment | http://test-platform.ferrystatic.com/openrisk/api/data/numberActive/query |
Request parameter
| Field | type | required | describe |
|---|---|---|---|
| appKey | string | yes | Unique identifier assigned to the organization |
| token | string | yes | API request signature, see token description |
| requestId | string | yes | requestId that you get from the Request Parameters Verification. |
Response parameters
| Field | type | required | describe |
|---|---|---|---|
| code | int | yes | error code |
| msg | string | yes | Error message |
| data | object | no | Always empty |
| requestId | string | yes | Request id |
| isFee | int | yes | 1- charge, 0- free |
Business parameters
| Field | type | required | describe |
|---|---|---|---|
| userPhone | String | Yes | The Phone Number |
| telcoType | int | Yes | 0 = not available 1 = prepaid 2 = postpaid |
| activeLevel | String | Yes | The Activity Level of the number : high = high activity medium = medium activity low = low activity NA = Data not available |
| frequencyGrade | String | Yes | Top Up Frequency : high = high activity medium = medium activity low = low activity NA = Data not available |
Response example
need query
{
"code": 200,
"msg": "ok",
"data": {
"userPhone": "628118899532",
"telcoType": 0,
"activeLevel": "NA",
"frequencyGrade": "NA"
},
"requestId": "e6d200fxxxxx7d4645aa66",
"isFee": 1
}
error
{
"code": 11008,
"msg": "xxxxxxx",
"data": null,
"requestId": "638211dexxxxxfc77718e079f6",
}